<!-- HTML header for doxygen 1.8.20-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
	<meta name="generator" content="Doxygen 1.9.4"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>Raspberry Pi Pico SDK: pio_instructions</title>
	<!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
	<link href="doxygen.css" rel="stylesheet" type="text/css" />
	<link href="normalise.css" rel="stylesheet" type="text/css"/>
<link href="main.css" rel="stylesheet" type="text/css"/>
<link href="styles.css" rel="stylesheet" type="text/css"/>
</head>
<body>
	<div class="navigation-mobile">
		<div class="logo--mobile">
			<a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
		</div>
		<div class="navigation-toggle">
			<span class="line-1"></span>
			<span class="line-2">
				<p>Menu Toggle</p>
			</span>
			<span class="line-3"></span>
		</div>
	</div>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
		<div class="logo">
			<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
			<span style="display: inline-block; margin-top: 10px;">
				v2.0.0
			</span>
		</div>
		<div class="navigation-footer">
			<img src="logo-mobile.svg" alt="Raspberry Pi">
			<a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
		</div>
<!-- 		<div class="search">
			<form>
				<input type="search" name="search" id="search" placeholder="Search">
				<input type="submit" value="Search">
			</form>
		</div> -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__pio__instructions.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">pio_instructions<div class="ingroups"><a class="el" href="group__hardware.html">Hardware APIs</a> &raquo; <a class="el" href="group__hardware__pio.html">hardware_pio</a></div></div></div>
</div><!--header-->
<div class="contents">

<p>PIO instruction encoding.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga52f7ffda150c44a085ead5c80a40352f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a> { <br />
&#160;&#160;<b>pio_pins</b> = 0u
, <b>pio_x</b> = 1u
, <b>pio_y</b> = 2u
, <b>pio_null</b> = 3u | 0x20u | 0x80u
, <br />
&#160;&#160;<b>pio_pindirs</b> = 4u | 0x08u | 0x40u | 0x80u
, <b>pio_exec_mov</b> = 4u | 0x08u | 0x10u | 0x20u | 0x40u
, <b>pio_status</b> = 5u | 0x08u | 0x10u | 0x20u | 0x80u
, <b>pio_pc</b> = 5u | 0x08u | 0x20u | 0x40u
, <br />
&#160;&#160;<b>pio_isr</b> = 6u | 0x20u
, <b>pio_osr</b> = 7u | 0x10u | 0x20u
, <b>pio_exec_out</b> = 7u | 0x08u | 0x20u | 0x40u | 0x80u
<br />
 }</td></tr>
<tr class="memdesc:ga52f7ffda150c44a085ead5c80a40352f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration of values to pass for source/destination args for instruction encoding functions.  <a href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">More...</a><br /></td></tr>
<tr class="separator:ga52f7ffda150c44a085ead5c80a40352f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga24aeafc5ee09e8f9c7b589c92beea72a"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a">pio_encode_delay</a> (uint cycles)</td></tr>
<tr class="memdesc:ga24aeafc5ee09e8f9c7b589c92beea72a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode just the delay slot bits of an instruction.  <a href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a">More...</a><br /></td></tr>
<tr class="separator:ga24aeafc5ee09e8f9c7b589c92beea72a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga983ded98ebaa885cf3ca0ebbcd8c8511"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511">pio_encode_sideset</a> (uint sideset_bit_count, uint value)</td></tr>
<tr class="memdesc:ga983ded98ebaa885cf3ca0ebbcd8c8511"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode just the side set bits of an instruction (in non optional side set mode)  <a href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511">More...</a><br /></td></tr>
<tr class="separator:ga983ded98ebaa885cf3ca0ebbcd8c8511"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4f6b4194e458dc4337777f99cfe48057"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057">pio_encode_sideset_opt</a> (uint sideset_bit_count, uint value)</td></tr>
<tr class="memdesc:ga4f6b4194e458dc4337777f99cfe48057"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode just the side set bits of an instruction (in optional -<code>opt</code> side set mode)  <a href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057">More...</a><br /></td></tr>
<tr class="separator:ga4f6b4194e458dc4337777f99cfe48057"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0fa70500aace834f01a207c0e9a73a22"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga0fa70500aace834f01a207c0e9a73a22">pio_encode_jmp</a> (uint addr)</td></tr>
<tr class="memdesc:ga0fa70500aace834f01a207c0e9a73a22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode an unconditional JMP instruction.  <a href="group__pio__instructions.html#ga0fa70500aace834f01a207c0e9a73a22">More...</a><br /></td></tr>
<tr class="separator:ga0fa70500aace834f01a207c0e9a73a22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6364142606d438862b78a32924685d06"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga6364142606d438862b78a32924685d06">pio_encode_jmp_not_x</a> (uint addr)</td></tr>
<tr class="memdesc:ga6364142606d438862b78a32924685d06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a conditional JMP if scratch X zero instruction.  <a href="group__pio__instructions.html#ga6364142606d438862b78a32924685d06">More...</a><br /></td></tr>
<tr class="separator:ga6364142606d438862b78a32924685d06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabfb50e373bb0be974d2a20fee51391ef"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#gabfb50e373bb0be974d2a20fee51391ef">pio_encode_jmp_x_dec</a> (uint addr)</td></tr>
<tr class="memdesc:gabfb50e373bb0be974d2a20fee51391ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a conditional JMP if scratch X non-zero (and post-decrement X) instruction.  <a href="group__pio__instructions.html#gabfb50e373bb0be974d2a20fee51391ef">More...</a><br /></td></tr>
<tr class="separator:gabfb50e373bb0be974d2a20fee51391ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac9b3ae0db062491f5dd9f202fbf1f61c"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#gac9b3ae0db062491f5dd9f202fbf1f61c">pio_encode_jmp_not_y</a> (uint addr)</td></tr>
<tr class="memdesc:gac9b3ae0db062491f5dd9f202fbf1f61c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a conditional JMP if scratch Y zero instruction.  <a href="group__pio__instructions.html#gac9b3ae0db062491f5dd9f202fbf1f61c">More...</a><br /></td></tr>
<tr class="separator:gac9b3ae0db062491f5dd9f202fbf1f61c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga779635bf3aac88181226769917284e05"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga779635bf3aac88181226769917284e05">pio_encode_jmp_y_dec</a> (uint addr)</td></tr>
<tr class="memdesc:ga779635bf3aac88181226769917284e05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a conditional JMP if scratch Y non-zero (and post-decrement Y) instruction.  <a href="group__pio__instructions.html#ga779635bf3aac88181226769917284e05">More...</a><br /></td></tr>
<tr class="separator:ga779635bf3aac88181226769917284e05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8681cd99b78d32c2dc487b3b4cf6562b"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga8681cd99b78d32c2dc487b3b4cf6562b">pio_encode_jmp_x_ne_y</a> (uint addr)</td></tr>
<tr class="memdesc:ga8681cd99b78d32c2dc487b3b4cf6562b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a conditional JMP if scratch X not equal scratch Y instruction.  <a href="group__pio__instructions.html#ga8681cd99b78d32c2dc487b3b4cf6562b">More...</a><br /></td></tr>
<tr class="separator:ga8681cd99b78d32c2dc487b3b4cf6562b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9494089ea30e55968884743b50233eee"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga9494089ea30e55968884743b50233eee">pio_encode_jmp_pin</a> (uint addr)</td></tr>
<tr class="memdesc:ga9494089ea30e55968884743b50233eee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a conditional JMP if input pin high instruction.  <a href="group__pio__instructions.html#ga9494089ea30e55968884743b50233eee">More...</a><br /></td></tr>
<tr class="separator:ga9494089ea30e55968884743b50233eee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf9fdae45a6ab4826175267c41d6e6e91"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#gaf9fdae45a6ab4826175267c41d6e6e91">pio_encode_jmp_not_osre</a> (uint addr)</td></tr>
<tr class="memdesc:gaf9fdae45a6ab4826175267c41d6e6e91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a conditional JMP if output shift register not empty instruction.  <a href="group__pio__instructions.html#gaf9fdae45a6ab4826175267c41d6e6e91">More...</a><br /></td></tr>
<tr class="separator:gaf9fdae45a6ab4826175267c41d6e6e91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4ef695ef0dfab6bb08dad4ab56a89da0"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga4ef695ef0dfab6bb08dad4ab56a89da0">pio_encode_wait_gpio</a> (bool polarity, uint gpio)</td></tr>
<tr class="memdesc:ga4ef695ef0dfab6bb08dad4ab56a89da0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a WAIT for GPIO pin instruction.  <a href="group__pio__instructions.html#ga4ef695ef0dfab6bb08dad4ab56a89da0">More...</a><br /></td></tr>
<tr class="separator:ga4ef695ef0dfab6bb08dad4ab56a89da0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafd946f6a77882a7f2c2d6a48b08529a7"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#gafd946f6a77882a7f2c2d6a48b08529a7">pio_encode_wait_pin</a> (bool polarity, uint pin)</td></tr>
<tr class="memdesc:gafd946f6a77882a7f2c2d6a48b08529a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a WAIT for pin instruction.  <a href="group__pio__instructions.html#gafd946f6a77882a7f2c2d6a48b08529a7">More...</a><br /></td></tr>
<tr class="separator:gafd946f6a77882a7f2c2d6a48b08529a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga40e02b4c097d3905b84a897aa2775072"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga40e02b4c097d3905b84a897aa2775072">pio_encode_wait_irq</a> (bool polarity, bool relative, uint irq)</td></tr>
<tr class="memdesc:ga40e02b4c097d3905b84a897aa2775072"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a WAIT for IRQ instruction.  <a href="group__pio__instructions.html#ga40e02b4c097d3905b84a897aa2775072">More...</a><br /></td></tr>
<tr class="separator:ga40e02b4c097d3905b84a897aa2775072"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8abee17fb296d7df2d4938fa25662bb5"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga8abee17fb296d7df2d4938fa25662bb5">pio_encode_in</a> (enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a> src, uint count)</td></tr>
<tr class="memdesc:ga8abee17fb296d7df2d4938fa25662bb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode an IN instruction.  <a href="group__pio__instructions.html#ga8abee17fb296d7df2d4938fa25662bb5">More...</a><br /></td></tr>
<tr class="separator:ga8abee17fb296d7df2d4938fa25662bb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6bdb43179b47dd61c15d346ba9cbed58"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga6bdb43179b47dd61c15d346ba9cbed58">pio_encode_out</a> (enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a> dest, uint count)</td></tr>
<tr class="memdesc:ga6bdb43179b47dd61c15d346ba9cbed58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode an OUT instruction.  <a href="group__pio__instructions.html#ga6bdb43179b47dd61c15d346ba9cbed58">More...</a><br /></td></tr>
<tr class="separator:ga6bdb43179b47dd61c15d346ba9cbed58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga44bd903b50c71bd5e18e1b3826a79867"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga44bd903b50c71bd5e18e1b3826a79867">pio_encode_push</a> (bool if_full, bool block)</td></tr>
<tr class="memdesc:ga44bd903b50c71bd5e18e1b3826a79867"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a PUSH instruction.  <a href="group__pio__instructions.html#ga44bd903b50c71bd5e18e1b3826a79867">More...</a><br /></td></tr>
<tr class="separator:ga44bd903b50c71bd5e18e1b3826a79867"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga69c0d008653d8bc0f8a985d699d9c6ba"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga69c0d008653d8bc0f8a985d699d9c6ba">pio_encode_pull</a> (bool if_empty, bool block)</td></tr>
<tr class="memdesc:ga69c0d008653d8bc0f8a985d699d9c6ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a PULL instruction.  <a href="group__pio__instructions.html#ga69c0d008653d8bc0f8a985d699d9c6ba">More...</a><br /></td></tr>
<tr class="separator:ga69c0d008653d8bc0f8a985d699d9c6ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad142265ea88bd5f9ef5f1651f5fa2002"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#gad142265ea88bd5f9ef5f1651f5fa2002">pio_encode_mov</a> (enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a> dest, enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a> src)</td></tr>
<tr class="memdesc:gad142265ea88bd5f9ef5f1651f5fa2002"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a MOV instruction.  <a href="group__pio__instructions.html#gad142265ea88bd5f9ef5f1651f5fa2002">More...</a><br /></td></tr>
<tr class="separator:gad142265ea88bd5f9ef5f1651f5fa2002"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5d6075e97f5a9e592700fdd09f09ea39"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga5d6075e97f5a9e592700fdd09f09ea39">pio_encode_mov_not</a> (enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a> dest, enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a> src)</td></tr>
<tr class="memdesc:ga5d6075e97f5a9e592700fdd09f09ea39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a MOV instruction with bit invert.  <a href="group__pio__instructions.html#ga5d6075e97f5a9e592700fdd09f09ea39">More...</a><br /></td></tr>
<tr class="separator:ga5d6075e97f5a9e592700fdd09f09ea39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab93b7ade8c9bd6b26213d4349c219994"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#gab93b7ade8c9bd6b26213d4349c219994">pio_encode_mov_reverse</a> (enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a> dest, enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a> src)</td></tr>
<tr class="memdesc:gab93b7ade8c9bd6b26213d4349c219994"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a MOV instruction with bit reverse.  <a href="group__pio__instructions.html#gab93b7ade8c9bd6b26213d4349c219994">More...</a><br /></td></tr>
<tr class="separator:gab93b7ade8c9bd6b26213d4349c219994"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2de1940b69cc1cd2c5e8d3d4eee653ba"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga2de1940b69cc1cd2c5e8d3d4eee653ba">pio_encode_irq_set</a> (bool relative, uint irq)</td></tr>
<tr class="memdesc:ga2de1940b69cc1cd2c5e8d3d4eee653ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a IRQ SET instruction.  <a href="group__pio__instructions.html#ga2de1940b69cc1cd2c5e8d3d4eee653ba">More...</a><br /></td></tr>
<tr class="separator:ga2de1940b69cc1cd2c5e8d3d4eee653ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae9221d56036ef5670eddd0d5ca93b5fd"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#gae9221d56036ef5670eddd0d5ca93b5fd">pio_encode_irq_wait</a> (bool relative, uint irq)</td></tr>
<tr class="memdesc:gae9221d56036ef5670eddd0d5ca93b5fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a IRQ WAIT instruction.  <a href="group__pio__instructions.html#gae9221d56036ef5670eddd0d5ca93b5fd">More...</a><br /></td></tr>
<tr class="separator:gae9221d56036ef5670eddd0d5ca93b5fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5d1238cddeb76680c7128933985f5ef0"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga5d1238cddeb76680c7128933985f5ef0">pio_encode_irq_clear</a> (bool relative, uint irq)</td></tr>
<tr class="memdesc:ga5d1238cddeb76680c7128933985f5ef0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a IRQ CLEAR instruction.  <a href="group__pio__instructions.html#ga5d1238cddeb76680c7128933985f5ef0">More...</a><br /></td></tr>
<tr class="separator:ga5d1238cddeb76680c7128933985f5ef0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae7094f127edb55a6d1d750145577eef8"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#gae7094f127edb55a6d1d750145577eef8">pio_encode_set</a> (enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a> dest, uint value)</td></tr>
<tr class="memdesc:gae7094f127edb55a6d1d750145577eef8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a SET instruction.  <a href="group__pio__instructions.html#gae7094f127edb55a6d1d750145577eef8">More...</a><br /></td></tr>
<tr class="separator:gae7094f127edb55a6d1d750145577eef8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga89ae8dfbcf647fb11c11a270cb974619"><td class="memItemLeft" align="right" valign="top">static uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pio__instructions.html#ga89ae8dfbcf647fb11c11a270cb974619">pio_encode_nop</a> (void)</td></tr>
<tr class="memdesc:ga89ae8dfbcf647fb11c11a270cb974619"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encode a NOP instruction.  <a href="group__pio__instructions.html#ga89ae8dfbcf647fb11c11a270cb974619">More...</a><br /></td></tr>
<tr class="separator:ga89ae8dfbcf647fb11c11a270cb974619"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p >PIO instruction encoding. </p>
<p >Functions for generating PIO instruction encodings programmatically. In debug builds <code>PARAM_ASSERTIONS_ENABLED_PIO_INSTRUCTIONS</code> can be set to 1 to enable validation of encoding function parameters.</p>
<p >For fuller descriptions of the instructions in question see the "RP2040 Datasheet" </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga52f7ffda150c44a085ead5c80a40352f" name="ga52f7ffda150c44a085ead5c80a40352f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga52f7ffda150c44a085ead5c80a40352f">&#9670;&nbsp;</a></span>pio_src_dest</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enumeration of values to pass for source/destination args for instruction encoding functions. </p>
<dl class="section note"><dt>Note</dt><dd>Not all values are suitable for all functions. Validity is only checked in debug mode when <code>PARAM_ASSERTIONS_ENABLED_PIO_INSTRUCTIONS</code> is 1 </dd></dl>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga24aeafc5ee09e8f9c7b589c92beea72a" name="ga24aeafc5ee09e8f9c7b589c92beea72a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga24aeafc5ee09e8f9c7b589c92beea72a">&#9670;&nbsp;</a></span>pio_encode_delay()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_delay </td>
          <td>(</td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>cycles</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode just the delay slot bits of an instruction. </p>
<dl class="section note"><dt>Note</dt><dd>This function does not return a valid instruction encoding; instead it returns an encoding of the delay slot suitable for <code>OR</code>ing with the result of an encoding function for an actual instruction. Care should be taken when combining the results of this function with the results of <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511">pio_encode_sideset</a> and <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057">pio_encode_sideset_opt</a> as they share the same bits within the instruction encoding.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cycles</td><td>the number of cycles 0-31 (or less if side set is being used) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the delay slot bits to be ORed with an instruction encoding </dd></dl>

</div>
</div>
<a id="ga8abee17fb296d7df2d4938fa25662bb5" name="ga8abee17fb296d7df2d4938fa25662bb5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8abee17fb296d7df2d4938fa25662bb5">&#9670;&nbsp;</a></span>pio_encode_in()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_in </td>
          <td>(</td>
          <td class="paramtype">enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a>&#160;</td>
          <td class="paramname"><em>src</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>count</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode an IN instruction. </p>
<p >This is the equivalent of <code>IN &lt;src&gt;, &lt;count&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">src</td><td>The source to take data from </td></tr>
    <tr><td class="paramname">count</td><td>The number of bits 1-32 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="ga5d1238cddeb76680c7128933985f5ef0" name="ga5d1238cddeb76680c7128933985f5ef0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d1238cddeb76680c7128933985f5ef0">&#9670;&nbsp;</a></span>pio_encode_irq_clear()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_irq_clear </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>relative</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>irq</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a IRQ CLEAR instruction. </p>
<p >This is the equivalent of <code>IRQ CLEAR &lt;irq&gt; &lt;relative&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">relative</td><td>true for a <code>IRQ CLEAR &lt;irq&gt; REL</code>, false for regular <code>IRQ CLEAR &lt;irq&gt;</code> </td></tr>
    <tr><td class="paramname">irq</td><td>the irq number 0-7 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="ga2de1940b69cc1cd2c5e8d3d4eee653ba" name="ga2de1940b69cc1cd2c5e8d3d4eee653ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2de1940b69cc1cd2c5e8d3d4eee653ba">&#9670;&nbsp;</a></span>pio_encode_irq_set()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_irq_set </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>relative</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>irq</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a IRQ SET instruction. </p>
<p >This is the equivalent of <code>IRQ SET &lt;irq&gt; &lt;relative&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">relative</td><td>true for a <code>IRQ SET &lt;irq&gt; REL</code>, false for regular <code>IRQ SET &lt;irq&gt;</code> </td></tr>
    <tr><td class="paramname">irq</td><td>the irq number 0-7 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="gae9221d56036ef5670eddd0d5ca93b5fd" name="gae9221d56036ef5670eddd0d5ca93b5fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae9221d56036ef5670eddd0d5ca93b5fd">&#9670;&nbsp;</a></span>pio_encode_irq_wait()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_irq_wait </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>relative</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>irq</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a IRQ WAIT instruction. </p>
<p >This is the equivalent of <code>IRQ WAIT &lt;irq&gt; &lt;relative&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">relative</td><td>true for a <code>IRQ WAIT &lt;irq&gt; REL</code>, false for regular <code>IRQ WAIT &lt;irq&gt;</code> </td></tr>
    <tr><td class="paramname">irq</td><td>the irq number 0-7 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="ga0fa70500aace834f01a207c0e9a73a22" name="ga0fa70500aace834f01a207c0e9a73a22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0fa70500aace834f01a207c0e9a73a22">&#9670;&nbsp;</a></span>pio_encode_jmp()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_jmp </td>
          <td>(</td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>addr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode an unconditional JMP instruction. </p>
<p >This is the equivalent of <code>JMP &lt;addr&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">addr</td><td>The target address 0-31 (an absolute address within the PIO instruction memory) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="gaf9fdae45a6ab4826175267c41d6e6e91" name="gaf9fdae45a6ab4826175267c41d6e6e91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf9fdae45a6ab4826175267c41d6e6e91">&#9670;&nbsp;</a></span>pio_encode_jmp_not_osre()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_jmp_not_osre </td>
          <td>(</td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>addr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a conditional JMP if output shift register not empty instruction. </p>
<p >This is the equivalent of <code>JMP !OSRE &lt;addr&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">addr</td><td>The target address 0-31 (an absolute address within the PIO instruction memory) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="ga6364142606d438862b78a32924685d06" name="ga6364142606d438862b78a32924685d06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6364142606d438862b78a32924685d06">&#9670;&nbsp;</a></span>pio_encode_jmp_not_x()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_jmp_not_x </td>
          <td>(</td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>addr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a conditional JMP if scratch X zero instruction. </p>
<p >This is the equivalent of <code>JMP !X &lt;addr&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">addr</td><td>The target address 0-31 (an absolute address within the PIO instruction memory) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="gac9b3ae0db062491f5dd9f202fbf1f61c" name="gac9b3ae0db062491f5dd9f202fbf1f61c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac9b3ae0db062491f5dd9f202fbf1f61c">&#9670;&nbsp;</a></span>pio_encode_jmp_not_y()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_jmp_not_y </td>
          <td>(</td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>addr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a conditional JMP if scratch Y zero instruction. </p>
<p >This is the equivalent of <code>JMP !Y &lt;addr&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">addr</td><td>The target address 0-31 (an absolute address within the PIO instruction memory) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="ga9494089ea30e55968884743b50233eee" name="ga9494089ea30e55968884743b50233eee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9494089ea30e55968884743b50233eee">&#9670;&nbsp;</a></span>pio_encode_jmp_pin()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_jmp_pin </td>
          <td>(</td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>addr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a conditional JMP if input pin high instruction. </p>
<p >This is the equivalent of <code>JMP PIN &lt;addr&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">addr</td><td>The target address 0-31 (an absolute address within the PIO instruction memory) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="gabfb50e373bb0be974d2a20fee51391ef" name="gabfb50e373bb0be974d2a20fee51391ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabfb50e373bb0be974d2a20fee51391ef">&#9670;&nbsp;</a></span>pio_encode_jmp_x_dec()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_jmp_x_dec </td>
          <td>(</td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>addr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a conditional JMP if scratch X non-zero (and post-decrement X) instruction. </p>
<p >This is the equivalent of <code>JMP X-- &lt;addr&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">addr</td><td>The target address 0-31 (an absolute address within the PIO instruction memory) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="ga8681cd99b78d32c2dc487b3b4cf6562b" name="ga8681cd99b78d32c2dc487b3b4cf6562b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8681cd99b78d32c2dc487b3b4cf6562b">&#9670;&nbsp;</a></span>pio_encode_jmp_x_ne_y()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_jmp_x_ne_y </td>
          <td>(</td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>addr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a conditional JMP if scratch X not equal scratch Y instruction. </p>
<p >This is the equivalent of <code>JMP X!=Y &lt;addr&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">addr</td><td>The target address 0-31 (an absolute address within the PIO instruction memory) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="ga779635bf3aac88181226769917284e05" name="ga779635bf3aac88181226769917284e05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga779635bf3aac88181226769917284e05">&#9670;&nbsp;</a></span>pio_encode_jmp_y_dec()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_jmp_y_dec </td>
          <td>(</td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>addr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a conditional JMP if scratch Y non-zero (and post-decrement Y) instruction. </p>
<p >This is the equivalent of <code>JMP Y-- &lt;addr&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">addr</td><td>The target address 0-31 (an absolute address within the PIO instruction memory) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="gad142265ea88bd5f9ef5f1651f5fa2002" name="gad142265ea88bd5f9ef5f1651f5fa2002"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad142265ea88bd5f9ef5f1651f5fa2002">&#9670;&nbsp;</a></span>pio_encode_mov()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_mov </td>
          <td>(</td>
          <td class="paramtype">enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a>&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a>&#160;</td>
          <td class="paramname"><em>src</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a MOV instruction. </p>
<p >This is the equivalent of <code>MOV &lt;dest&gt;, &lt;src&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">dest</td><td>The destination to write data to </td></tr>
    <tr><td class="paramname">src</td><td>The source to take data from </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="ga5d6075e97f5a9e592700fdd09f09ea39" name="ga5d6075e97f5a9e592700fdd09f09ea39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d6075e97f5a9e592700fdd09f09ea39">&#9670;&nbsp;</a></span>pio_encode_mov_not()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_mov_not </td>
          <td>(</td>
          <td class="paramtype">enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a>&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a>&#160;</td>
          <td class="paramname"><em>src</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a MOV instruction with bit invert. </p>
<p >This is the equivalent of <code>MOV &lt;dest&gt;, ~&lt;src&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">dest</td><td>The destination to write inverted data to </td></tr>
    <tr><td class="paramname">src</td><td>The source to take data from </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="gab93b7ade8c9bd6b26213d4349c219994" name="gab93b7ade8c9bd6b26213d4349c219994"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab93b7ade8c9bd6b26213d4349c219994">&#9670;&nbsp;</a></span>pio_encode_mov_reverse()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_mov_reverse </td>
          <td>(</td>
          <td class="paramtype">enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a>&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a>&#160;</td>
          <td class="paramname"><em>src</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a MOV instruction with bit reverse. </p>
<p >This is the equivalent of <code>MOV &lt;dest&gt;, ::&lt;src&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">dest</td><td>The destination to write bit reversed data to </td></tr>
    <tr><td class="paramname">src</td><td>The source to take data from </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="ga89ae8dfbcf647fb11c11a270cb974619" name="ga89ae8dfbcf647fb11c11a270cb974619"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga89ae8dfbcf647fb11c11a270cb974619">&#9670;&nbsp;</a></span>pio_encode_nop()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_nop </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a NOP instruction. </p>
<p >This is the equivalent of <code>NOP</code> which is itself encoded as <code>MOV y, y</code></p>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="ga6bdb43179b47dd61c15d346ba9cbed58" name="ga6bdb43179b47dd61c15d346ba9cbed58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6bdb43179b47dd61c15d346ba9cbed58">&#9670;&nbsp;</a></span>pio_encode_out()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_out </td>
          <td>(</td>
          <td class="paramtype">enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a>&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>count</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode an OUT instruction. </p>
<p >This is the equivalent of <code>OUT &lt;src&gt;, &lt;count&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">dest</td><td>The destination to write data to </td></tr>
    <tr><td class="paramname">count</td><td>The number of bits 1-32 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="ga69c0d008653d8bc0f8a985d699d9c6ba" name="ga69c0d008653d8bc0f8a985d699d9c6ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga69c0d008653d8bc0f8a985d699d9c6ba">&#9670;&nbsp;</a></span>pio_encode_pull()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_pull </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>if_empty</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>block</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a PULL instruction. </p>
<p >This is the equivalent of <code>PULL &lt;if_empty&gt;, &lt;block&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">if_empty</td><td>true for <code>PULL IF_EMPTY ...</code>, false for <code>PULL ...</code> </td></tr>
    <tr><td class="paramname">block</td><td>true for <code>PULL ... BLOCK</code>, false for <code>PULL ...</code> </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="ga44bd903b50c71bd5e18e1b3826a79867" name="ga44bd903b50c71bd5e18e1b3826a79867"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga44bd903b50c71bd5e18e1b3826a79867">&#9670;&nbsp;</a></span>pio_encode_push()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_push </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>if_full</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>block</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a PUSH instruction. </p>
<p >This is the equivalent of <code>PUSH &lt;if_full&gt;, &lt;block&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">if_full</td><td>true for <code>PUSH IF_FULL ...</code>, false for <code>PUSH ...</code> </td></tr>
    <tr><td class="paramname">block</td><td>true for <code>PUSH ... BLOCK</code>, false for <code>PUSH ...</code> </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="gae7094f127edb55a6d1d750145577eef8" name="gae7094f127edb55a6d1d750145577eef8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae7094f127edb55a6d1d750145577eef8">&#9670;&nbsp;</a></span>pio_encode_set()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_set </td>
          <td>(</td>
          <td class="paramtype">enum <a class="el" href="group__pio__instructions.html#ga52f7ffda150c44a085ead5c80a40352f">pio_src_dest</a>&#160;</td>
          <td class="paramname"><em>dest</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a SET instruction. </p>
<p >This is the equivalent of <code>SET &lt;dest&gt;, &lt;value&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">dest</td><td>The destination to apply the value to </td></tr>
    <tr><td class="paramname">value</td><td>The value 0-31 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="ga983ded98ebaa885cf3ca0ebbcd8c8511" name="ga983ded98ebaa885cf3ca0ebbcd8c8511"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga983ded98ebaa885cf3ca0ebbcd8c8511">&#9670;&nbsp;</a></span>pio_encode_sideset()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_sideset </td>
          <td>(</td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>sideset_bit_count</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode just the side set bits of an instruction (in non optional side set mode) </p>
<dl class="section note"><dt>Note</dt><dd>This function does not return a valid instruction encoding; instead it returns an encoding of the side set bits suitable for <code>OR</code>ing with the result of an encoding function for an actual instruction. Care should be taken when combining the results of this function with the results of <a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a">pio_encode_delay</a> as they share the same bits within the instruction encoding.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sideset_bit_count</td><td>number of side set bits as would be specified via <code>.sideset</code> in pioasm </td></tr>
    <tr><td class="paramname">value</td><td>the value to sideset on the pins </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the side set bits to be ORed with an instruction encoding </dd></dl>

</div>
</div>
<a id="ga4f6b4194e458dc4337777f99cfe48057" name="ga4f6b4194e458dc4337777f99cfe48057"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4f6b4194e458dc4337777f99cfe48057">&#9670;&nbsp;</a></span>pio_encode_sideset_opt()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_sideset_opt </td>
          <td>(</td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>sideset_bit_count</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode just the side set bits of an instruction (in optional -<code>opt</code> side set mode) </p>
<dl class="section note"><dt>Note</dt><dd>This function does not return a valid instruction encoding; instead it returns an encoding of the side set bits suitable for <code>OR</code>ing with the result of an encoding function for an actual instruction. Care should be taken when combining the results of this function with the results of <a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a">pio_encode_delay</a> as they share the same bits within the instruction encoding.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sideset_bit_count</td><td>number of side set bits as would be specified via <code>.sideset &lt;n&gt; opt</code> in pioasm </td></tr>
    <tr><td class="paramname">value</td><td>the value to sideset on the pins </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the side set bits to be ORed with an instruction encoding </dd></dl>

</div>
</div>
<a id="ga4ef695ef0dfab6bb08dad4ab56a89da0" name="ga4ef695ef0dfab6bb08dad4ab56a89da0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4ef695ef0dfab6bb08dad4ab56a89da0">&#9670;&nbsp;</a></span>pio_encode_wait_gpio()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_wait_gpio </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>polarity</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>gpio</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a WAIT for GPIO pin instruction. </p>
<p >This is the equivalent of <code>WAIT &lt;polarity&gt; GPIO &lt;gpio&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">polarity</td><td>true for <code>WAIT 1</code>, false for <code>WAIT 0</code> </td></tr>
    <tr><td class="paramname">gpio</td><td>The real GPIO number 0-31 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="ga40e02b4c097d3905b84a897aa2775072" name="ga40e02b4c097d3905b84a897aa2775072"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga40e02b4c097d3905b84a897aa2775072">&#9670;&nbsp;</a></span>pio_encode_wait_irq()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_wait_irq </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>polarity</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>relative</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>irq</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a WAIT for IRQ instruction. </p>
<p >This is the equivalent of <code>WAIT &lt;polarity&gt; IRQ &lt;irq&gt; &lt;relative&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">polarity</td><td>true for <code>WAIT 1</code>, false for <code>WAIT 0</code> </td></tr>
    <tr><td class="paramname">relative</td><td>true for a <code>WAIT IRQ &lt;irq&gt; REL</code>, false for regular <code>WAIT IRQ &lt;irq&gt;</code> </td></tr>
    <tr><td class="paramname">irq</td><td>the irq number 0-7 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
<a id="gafd946f6a77882a7f2c2d6a48b08529a7" name="gafd946f6a77882a7f2c2d6a48b08529a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafd946f6a77882a7f2c2d6a48b08529a7">&#9670;&nbsp;</a></span>pio_encode_wait_pin()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static uint pio_encode_wait_pin </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>polarity</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>pin</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Encode a WAIT for pin instruction. </p>
<p >This is the equivalent of <code>WAIT &lt;polarity&gt; PIN &lt;pin&gt;</code></p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">polarity</td><td>true for <code>WAIT 1</code>, false for <code>WAIT 0</code> </td></tr>
    <tr><td class="paramname">pin</td><td>The pin number 0-31 relative to the executing SM's input pin mapping </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The instruction encoding with 0 delay and no side set value </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__pio__instructions.html#ga24aeafc5ee09e8f9c7b589c92beea72a" title="Encode just the delay slot bits of an instruction.">pio_encode_delay</a>, <a class="el" href="group__pio__instructions.html#ga983ded98ebaa885cf3ca0ebbcd8c8511" title="Encode just the side set bits of an instruction (in non optional side set mode)">pio_encode_sideset</a>, <a class="el" href="group__pio__instructions.html#ga4f6b4194e458dc4337777f99cfe48057" title="Encode just the side set bits of an instruction (in optional -opt side set mode)">pio_encode_sideset_opt</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->

	<script src="main.js"></script>
</body>
</html>